Indicate deprecated option aliases #24359
Conversation
Gedochao
added
backport:nominated
| val Vprint: Setting[List[String]] = PhasesSetting(VerboseSetting, "Vprint", "Print out program after", aliases = List("-Xprint")) | ||
| val XshowPhases: Setting[Boolean] = BooleanSetting(VerboseSetting, "Vphases", "List compiler phases.", aliases = List("-Xshow-phases")) | ||
| val Vprint: Setting[List[String]] = PhasesSetting(VerboseSetting, "Vprint", "Print out program after", aliases = List("-Xprint*")) | ||
| val XshowPhases: Setting[Boolean] = BooleanSetting(VerboseSetting, "Vphases", "List compiler phases.", aliases = List("-Xshow-phases*")) |
There was a problem hiding this comment.
Maybe it would be clearer to add a new list deprecatedAliases?
There was a problem hiding this comment.
+1
that'd actually be more readable for when the API would be read outside of the compiler, as well.
There was a problem hiding this comment.
OK, the people have spoken!
som-snytt
force-pushed
the
issue/24333
branch
from
63b349d to
3e5558c
Compare
|
rando download error Edit: followed by need to update shapeless-3 options. |
som-snytt
force-pushed
the
issue/24333
branch
from
fafb6e2 to
33c7445
Compare
|
Technically, the number of parameters to a method should be capped at a gazillion, which was one reason to like the first, cute solution. |
| preferPrevious: Boolean = false, | ||
| propertyClass: Option[Class[?]] = None, | ||
| deprecation: Option[Deprecation] = None, | ||
| deprecatedAliases: List[(String, Deprecation)] = Nil, |
There was a problem hiding this comment.
nitpick: wouldn't it increase readability to have a
case class SettingAlias(name: String, deprecation: Option[Deprecation] = None)
?
or at the very least, use a named tuple here 🤔
There was a problem hiding this comment.
Thanks, I'm not accustomed to such fancy language features. I'll update it.
I found consolation in the thought that deprecated aliases are rare, and it's OK if they are awkward to write.
4 participants
Fixes #24333
Specify deprecated aliases with
deprecatedAliases. The message is "optional" (may be empty).